IRIX Base Documentation 2002 November/SGI IRIX Base Documentation 2002 November.iso/usr/share/catman/p_man/cat3/Vk/VkOlNode.z/VkOlNode

Text File | 2002-10-03 | 7.1 KB | 265 lines

VVVVkkkkOOOOllllNNNNooooddddeeee((((3333xxxx))))                                                      VVVVkkkkOOOOllllNNNNooooddddeeee((((3333xxxx))))



NNNNAAAAMMMMEEEE
     VkOlNode - A utility class used by VkOutline

HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
     #include <Vk/VkOutline.h>

PPPPUUUUBBBBLLLLIIIICCCC PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
   CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr////DDDDeeeessssttttrrrruuuuccccttttoooorrrr
           VkOlNode (char *name);
           VkOlNode (char *name, void* data);
           VkOlNode (char *name, char* key, void* data);

           virtual void ~VkOlNode(void);


   PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr FFFFuuuunnnnccccttttiiiioooonnnnssss
           void      addChild (VkOlNode* child);
           void      removeChild (VkOlNode* child);
           VkOlNode* pathToNode (char** path);
           XmString  name ();
           char*     key ();
           void*     getHook ();
           int       nchild ();
           VkOlNode* child (int);
           void      setParent (VkOlNode*);
           VkOlNode* getParent ();
           int       isOpen ();
           void      Open ();
           void      Close ();


CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     The VkOlNode is an utility class for VkOutline, VkOutlineASB components.
     In addition to being helpful as a node in the outline tree, it provides
     ways for outline components to manage opening, closing, display attribute
     setting and searching. Some public methods documented here can be used by
     derived class implementors for VkOutline, VkOutlineASB. They can also be
     helpful to users of VkOutline::walkAllKeywords. A VkOlNode has a display
     string (name), a key used in searching and a hook - user defined opaque
     data pointer. It also maintains display status and attributes.

FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
   VVVVkkkkOOOOllllNNNNooooddddeeee(((())))
           VkOlNode(char* name);


          Instantiate a VkOlNode object given its name. The key is same as
          name.  Data pointer is initialized to NULL.

   VVVVkkkkOOOOllllNNNNooooddddeeee(((())))





                                                                        PPPPaaaaggggeeee 1111






VVVVkkkkOOOOllllNNNNooooddddeeee((((3333xxxx))))                                                      VVVVkkkkOOOOllllNNNNooooddddeeee((((3333xxxx))))



           VkOlNode(char* name, char* key);


          Instantiate a VkOlNode object given its name and key. Data pointer
          is initialized to NULL.

   VVVVkkkkOOOOllllNNNNooooddddeeee(((())))
           VkOlNode(char* name, char* key, void* data);


          Instantiate a VkOlNode object given its name, key and data pointer.

   ~~~~VVVVkkkkOOOOllllNNNNooooddddeeee(((())))
           virtual void ~VkOlNode(void);


          Destroy a VkOlNode object after deleting all its children.

   aaaaddddddddCCCChhhhiiiilllldddd(((())))
           void      addChild (VkOlNode* child);


          Add the given child to list of children in the node.

   rrrreeeemmmmoooovvvveeeeCCCChhhhiiiilllldddd(((())))
           void      removeChild (VkOlNode* child);


          Remove the given child to list of children in the node.

   ppppaaaatttthhhhTTTTooooNNNNooooddddeeee(((())))
           VkOlNode* pathToNode (char** path);


          Parameter path is an array of strings with the last one NULL.
          Returns a node corresponding to the path relative to the node, by
          traversing the node's child hierarchy.

   nnnnaaaammmmeeee(((())))
           XmString  name ();


          Returns the name given while instantiating the node.

   kkkkeeeeyyyy(((())))
           char*     key ();


          Returns the key corresponding to the node.






                                                                        PPPPaaaaggggeeee 2222






VVVVkkkkOOOOllllNNNNooooddddeeee((((3333xxxx))))                                                      VVVVkkkkOOOOllllNNNNooooddddeeee((((3333xxxx))))



   ggggeeeettttHHHHooooooookkkk(((())))
           void*     getHook ();


          Returns the data pointer corresponding to the node.

   nnnncccchhhhiiiilllldddd(((())))
           int       nchild ();


          Returns the number of children in the node.

   cccchhhhiiiilllldddd(((())))
           VkOlNode* child (int i);


          Returns the i'th child node.

   sssseeeettttPPPPaaaarrrreeeennnntttt(((())))
           void      setParent (VkOlNode* parent);


          Sets a given node as its parent.

   ggggeeeettttPPPPaaaarrrreeeennnntttt(((())))
           VkOlNode* getParent ();


          Returns the parent of the node.

   iiiissssOOOOppppeeeennnn(((())))
           int       isOpen ();


          Returns whether the node is open, i.e., whether its children are
          displayed.

   OOOOppppeeeennnn(((())))
           void      Open ();


          Takes the node to open state, i.e., its children will be
          displayable.

   CCCClllloooosssseeee(((())))
           void      Close ();


          Takes the node to closed state, i.e., its children will not be
          displayable.





                                                                        PPPPaaaaggggeeee 3333






VVVVkkkkOOOOllllNNNNooooddddeeee((((3333xxxx))))                                                      VVVVkkkkOOOOllllNNNNooooddddeeee((((3333xxxx))))



SSSSEEEEEEEE AAAALLLLSSSSOOOO
     VkOutline, VkOutlineASB
     _V_i_e_w_K_i_t _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e
     _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m, DEC Press, Bob Sheifler and Jim Gettys
     _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m _T_o_o_l_k_i_t, DEC Press, Paul Asente and Ralph Swick
     _T_h_e _O_S_F/_M_o_t_i_f _P_r_o_g_r_a_m_m_e_r_s _R_e_f_e_r_e_n_c_e, Prentice Hall, OSF

















































                                                                        PPPPaaaaggggeeee 4444